home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / bbs / g5108b.zip / G5.ZIP / TEXT / XPORTS.TXT < prev   
Text File  |  1996-06-17  |  17KB  |  285 lines
  1.  
  2.                               ──══ Galaxy 5 ══──
  3.                       Copyright (c) 1996 Thomas J. Smith
  4.  
  5.      ────────────────────────────────────────────────────────────────────
  6.       This text file explains the use of Xports, how to install and use
  7.       them, and how to go about creating your own!
  8.      ────────────────────────────────────────────────────────────────────
  9.       For a complete listing of data file structures, formats of all of
  10.       the drop files that G5 creates, and a complete list of color, and
  11.       other codes, unzip the G5_STRUC.ZIP archive. Everything 3rd party
  12.       programmers need is located in this archive!
  13.      ────────────────────────────────────────────────────────────────────
  14.  
  15.  
  16.                                  HOW THEY WORK
  17.      ────────────────────────────────────────────────────────────────────
  18.       In order to explain this in the simplest way, I will use an
  19.       example. Lets say Joe SysOp just downloaded an Xport called
  20.       "Hermans World." First, Joe unzips the file he just downloaded to
  21.       a temporary directory (or the directory he wishes the Xport to be
  22.       installed to). Then Joe will read the docs that came with the .ZIP
  23.       file first (or will he?). In the docs, Joe will find that all he
  24.       needs to do to install this Xport, is run the INSTALL.EXE program
  25.       included with the .ZIP file (or other installation method). The
  26.       install program then puts all the necessarry files in their proper
  27.       places, and writes the needed info to the XPORTS.DAT file in Joes
  28.       main Galaxy 5 directory.
  29.      ────────────────────────────────────────────────────────────────────
  30.       Now to use the Xport, Joe logs on to Galaxy 5 either locally, or
  31.       by logging on to his BBS locally, and running the game from there.
  32.       From the main menu (Lexor Street, or whichever planet he is on),
  33.       Joe will choose the option, "(X)port to another place." Then he is
  34.       taken to a menu listing all of the Xports he has installed. If he
  35.       only installed one Xport, then only the name of that one Xport
  36.       will be listed as number (1). Joe then presses 1 to go to this
  37.       Xport, and wala! Thats all there is to it. After Joe is done using
  38.       the Xport, Galaxy 5 reloads, and picks up from the Xport menu
  39.       where it left off, and deducts the time that Joe was in the Xport
  40.       from his time left in the game!
  41.      ────────────────────────────────────────────────────────────────────
  42.       Then later (or right after trying it), if Joe finds that he does
  43.       not like this Xport, he runs the UNINSTAL.EXE program that came
  44.       with the Xport (or whatever program the Xports docs point him
  45.       to), and the game is "uninstalled!"
  46.      ────────────────────────────────────────────────────────────────────
  47.  
  48.  
  49.                                      Q & A
  50.      ────────────────────────────────────────────────────────────────────
  51.        Q. What is an Xport?
  52.       ----------------------
  53.        A. An Xport is an external program (door) created by third
  54.           party programmers for use in your Galaxy 5 game. They can
  55.           be run directly from within the game, without any special
  56.           setup on the SysOps part!
  57.      ────────────────────────────────────────────────────────────────────
  58.        Q. Where can I find an Xport?
  59.       -------------------------------
  60.        A. Good question! Depending on how well Galaxy 5 does with
  61.           popularity, it may or may not be hard to find an Xport.
  62.           However, I have created a freeware Xport named "The Inscribers
  63.           Guild." It allows players to personalize their Armour, Weapon,
  64.           and Space Craft at a price the SysOp sets. SysOp can also
  65.           disallow personalizing of any of the three items mentioned.
  66.           Look for SCRIBE??.ZIP (where ?? is the version number).
  67.      ────────────────────────────────────────────────────────────────────
  68.        Q. If I find one, how do I set it up?
  69.       ---------------------------------------
  70.        A. It should be extremely simple to set up. As a ground rule,
  71.           any Xport created by a third party programmer, must come
  72.           with an easy to use install program, and easy to use
  73.           "uninstall" program in case the SysOp does not like it, or
  74.           needs to remove it for some reason. The SysOp installing the
  75.           Xport, should not have to do anything else but run the
  76.           INSTALL program that comes with the Xport!
  77.      ────────────────────────────────────────────────────────────────────
  78.        Q. What if an Xport I installed doesn't work properly?
  79.       --------------------------------------------------------
  80.        A. Read the docs that came with it. If the author(s) of the Xport
  81.           provides support for the program, then follow their
  82.           instructions on how to obtain that support. It is beyond my
  83.           ability to help with problems concerning someone elses
  84.           program! :) If all else fails, remove the Xport from your
  85.           game. If the Xport just happened not to come with an
  86.           uninstall program, then remove the two lines in the
  87.           XPORTS.DAT file that pertain to that Xport.
  88.      ────────────────────────────────────────────────────────────────────
  89.        Q. I write doors, how can I make an Xport?
  90.       --------------------------------------------
  91.        A. If the door writing kit that you use supports the Quick BBS
  92.           drop file format (DORINFO*.DEF where * is the node number),
  93.           then you may already have what you need to write your own
  94.           Xport! Galaxy 5 creates 3 drop files before running an Xport,
  95.           one of which is a DORINFO*.DEF compatible drop file. Figure
  96.           out some way to have your Xport read this drop file (located
  97.           in the TEMP subdirectory), and it -should- be all you need!
  98.           Other door writing kits that are directly supported are UrDoor,
  99.           and the DDplus door driver kit. Read the next section,
  100.           "Creating Your Own Xports." It explains everything you need to
  101.           know!
  102.      ────────────────────────────────────────────────────────────────────
  103.  
  104.  
  105.                            CREATING YOUR OWN XPORTS
  106.      ────────────────────────────────────────────────────────────────────
  107.       ** Unzip the G5_STRUC.ZIP archive!! It contains everything you
  108.          need to know!!! ;>
  109.      ────────────────────────────────────────────────────────────────────
  110.       If you do not program in Turbo Pascal, and would still like to
  111.       make an Xport for Galaxy 5, then refer to the G5_STRUC.ZIP
  112.       archive. Galaxy 5 creates a plain text drop file containing the
  113.       callers full record information, in which you can make changes to,
  114.       and Galaxy 5 will accept the changes upon returning from your
  115.       Xport.
  116.      ────────────────────────────────────────────────────────────────────
  117.       Before your creation(s) can be "officially" called Xports, you
  118.       must follow these 3 simple rules:
  119.      ────────────────────────────────────────────────────────────────────
  120.       1 ■ It must come with an easy to use install program, and an easy
  121.           to use uninstall program. These can be implemented as separate
  122.           .EXE's, or as command line switches in your game, or whatever.
  123.           What the install program must do, is place its game files in
  124.           the proper directory (preferably its own directory off of the
  125.           main Galaxy 5 directory), and write its needed two lines to
  126.           the XPORTS.DAT file located in the main Galaxy 5 directory.
  127.           The XPORTS.DAT file, is a regular text file, listing the name
  128.           of your Xport as it will be shown to callers first, and then
  129.           the command line you want passed to your door when a player
  130.           uses the Xport on the second line. Here is an example,
  131.  
  132.           ~0B~T~01~he ~0B~I~01~nscribers ~0B~G~01~uild
  133.           C:\DOORS\GALAXY5\SCRIBES\SCRIBES.EXE ~UN~
  134.  
  135.           In the above example, the characters in between the tilde (~)
  136.           signs are codes use